<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: /bb/mbigc/mbig5696/git/quantum_external/src/impl/quantum_buffer_impl.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d1/d2a/quantum__buffer__impl_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">quantum_buffer_impl.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">** Copyright 2018 Bloomberg Finance L.P.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">** You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">**     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">** limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">//NOTE: DO NOT INCLUDE DIRECTLY</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">//##############################################################################################</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">//#################################### IMPLEMENTATIONS #########################################</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">//##############################################################################################</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="../../d6/db9/namespaceBloomberg.html">   22</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a> {</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../dc/d48/namespaceBloomberg_1_1quantum.html">   23</a></span>&#160;<span class="keyword">namespace </span>quantum {</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ALLOCATOR&gt;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#a3a03390bf5f8259c46250369efeb647b">   26</a></span>&#160;<a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#a3a03390bf5f8259c46250369efeb647b">Buffer&lt;T,ALLOCATOR&gt;::Buffer</a>(<span class="keyword">const</span> ALLOCATOR&amp; allocator) :</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    _buffer(allocator),</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    _isClosed(false)</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;{}</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ALLOCATOR&gt;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> V&gt;</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#a0f7ff17c89f6dcfc4651f31b6e466b16">   33</a></span>&#160;<a class="code" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a9322decc3c78f19a6262e572bd276b5f">BufferStatus</a> <a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html">Buffer&lt;T,ALLOCATOR&gt;::push</a>(V&amp;&amp; value)</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;{</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keywordflow">if</span> (_isClosed)</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    {</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;        <span class="keywordflow">return</span> BufferStatus::Closed;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    }</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    _buffer.push_back(std::forward&lt;V&gt;(value));</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keywordflow">return</span> BufferStatus::DataPosted;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;}</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ALLOCATOR&gt;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#afa86fb6ab65316f884e2392050bf2aed">   44</a></span>&#160;<a class="code" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a9322decc3c78f19a6262e572bd276b5f">BufferStatus</a> <a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html">Buffer&lt;T,ALLOCATOR&gt;::pull</a>(T&amp; value)</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;{</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="keywordflow">if</span> (_buffer.empty())</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    {</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;        <span class="keywordflow">return</span> _isClosed ? BufferStatus::Closed : BufferStatus::DataPending;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    }</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    value = std::move(_buffer.front());</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    _buffer.pop_front();</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="keywordflow">return</span> BufferStatus::DataReceived;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;}</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ALLOCATOR&gt;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#a1449c6d0ca59c621fb04f0e6cef00e44">   56</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html">Buffer&lt;T,ALLOCATOR&gt;::close</a>()</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;{</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    _isClosed = <span class="keyword">true</span>;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;}</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ALLOCATOR&gt;</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#a0d7a77984b777fcd555583d4eb4d3b6f">   62</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html">Buffer&lt;T,ALLOCATOR&gt;::isClosed</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keyword"></span>{</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordflow">return</span> _isClosed;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;}</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ALLOCATOR&gt;</div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#af3ea4c4ca2b82d56bd9cbb69c3221596">   68</a></span>&#160;<span class="keywordtype">size_t</span> <a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html">Buffer&lt;T,ALLOCATOR&gt;::size</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="keyword"></span>{</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keywordflow">return</span> _buffer.<a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#af3ea4c4ca2b82d56bd9cbb69c3221596">size</a>();</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;}</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T, <span class="keyword">class</span> ALLOCATOR&gt;</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#ad84dbc76f0914e603c7b91d6d56a6aa9">   74</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html">Buffer&lt;T,ALLOCATOR&gt;::empty</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="keyword"></span>{</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordflow">return</span> _buffer.<a class="code" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#ad84dbc76f0914e603c7b91d6d56a6aa9">empty</a>();</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;}</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;}}</div><div class="ttc" id="namespaceBloomberg_html"><div class="ttname"><a href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:22</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Buffer_html_a3a03390bf5f8259c46250369efeb647b"><div class="ttname"><a href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#a3a03390bf5f8259c46250369efeb647b">Bloomberg::quantum::Buffer::Buffer</a></div><div class="ttdeci">Buffer(const ALLOCATOR &amp;alloc=ALLOCATOR())</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:26</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Buffer_html_af3ea4c4ca2b82d56bd9cbb69c3221596"><div class="ttname"><a href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#af3ea4c4ca2b82d56bd9cbb69c3221596">Bloomberg::quantum::Buffer::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Indicates the number of values stored in the buffer.</div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:68</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Buffer_html"><div class="ttname"><a href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html">Bloomberg::quantum::Buffer</a></div><div class="ttdoc">Container which allows buffered access to a series of values. Values are pushed-in (written) by a pro...</div><div class="ttdef"><b>Definition:</b> quantum_buffer.h:49</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1Buffer_html_ad84dbc76f0914e603c7b91d6d56a6aa9"><div class="ttname"><a href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html#ad84dbc76f0914e603c7b91d6d56a6aa9">Bloomberg::quantum::Buffer::empty</a></div><div class="ttdeci">bool empty() const</div><div class="ttdoc">Helper function equivalent to size() == 0;.</div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:74</div></div>
<div class="ttc" id="namespaceBloomberg_1_1quantum_html_a9322decc3c78f19a6262e572bd276b5f"><div class="ttname"><a href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a9322decc3c78f19a6262e572bd276b5f">Bloomberg::quantum::BufferStatus</a></div><div class="ttdeci">BufferStatus</div><div class="ttdoc">Defines the result of the operation on the buffer object.</div><div class="ttdef"><b>Definition:</b> quantum_buffer.h:32</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_3808e3f8fe545b07b1d2715928fb0eea.html">impl</a></li><li class="navelem"><b>quantum_buffer_impl.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
